UNL iOS SDK SDK Package Other Classes

Other Classes

MGLAttributedExpression


          @interface MGLAttributedExpression : NSObject

An MGLAttributedExpression object associates text formatting attibutes (such as font size or font names) to an NSExpression.

Example

let redColor = UIColor.red
                        let expression = NSExpression(forConstantValue: "Foo")
                        let attributes: [MGLAttributedExpressionKey: NSExpression] = [.fontNamesAttribute : NSExpression(forConstantValue: ["DIN Offc Pro Italic",
                        "Arial Unicode MS Regular"]),
                        .fontScaleAttribute: NSExpression(forConstantValue: 1.2),
                        .fontColorAttribute: NSExpression(forConstantValue: redColor)]
                        let attributedExpression = MGLAttributedExpression(expression, attributes:attributes)

  • expression

    The expression content of the receiver as NSExpression.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSExpression *_Nonnull expression;

    Swift

    var expression: NSExpression { get set }
    View Source on GitHub

  • attributes

    The formatting attributes dictionary. Key | Value Type — | — MGLFontNamesAttribute | An NSExpression evaluating to an NSString array. MGLFontScaleAttribute | An NSExpression evaluating to an NSNumber value. MGLFontColorAttribute | An NSExpression evaluating to an UIColor.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSDictionary<MGLAttributedExpressionKey, NSExpression *> *_Nonnull attributes;

    Swift

    var attributes: [MGLAttributedExpressionKey : NSExpression] { get }
    View Source on GitHub

  • -initWithExpression:

    Returns an MGLAttributedExpression object initialized with an expression and no attribute information.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithExpression:(nonnull NSExpression *)expression;

    Swift

    init(expression: NSExpression)
    View Source on GitHub

  • -initWithExpression:attributes:

    Returns an MGLAttributedExpression object initialized with an expression and text format attributes.

    Declaration

    Objective-C

    - (nonnull instancetype)
              initWithExpression:(nonnull NSExpression *)expression
                      attributes:(nonnull NSDictionary<MGLAttributedExpressionKey,
                                                       NSExpression *> *)attrs;

    Swift

    init(expression: NSExpression, attributes attrs: [MGLAttributedExpressionKey : NSExpression] = [:])
    View Source on GitHub

  • +attributedExpression:fontNames:fontScale:

    Creates an MGLAttributedExpression object initialized with an expression and the format attributes for font names and font size.

    Declaration

    Objective-C

    + (nonnull instancetype)attributedExpression:(nonnull NSExpression *)expression
                                             fontNames:
                                                 (nullable NSArray<NSString *> *)fontNames
                                             fontScale:(nullable NSNumber *)fontScale;

    Swift

    convenience init(_ expression: NSExpression, fontNames: [String]?, fontScale: NSNumber?)
    View Source on GitHub

  • +attributedExpression:attributes:

    Creates an MGLAttributedExpression object initialized with an expression and the format attributes dictionary.

    Declaration

    Objective-C

    + (nonnull instancetype)
              attributedExpression:(nonnull NSExpression *)expression
                        attributes:(nonnull NSDictionary<MGLAttributedExpressionKey,
                                                         NSExpression *> *)attrs;

    Swift

    convenience init(_ expression: NSExpression, attributes attrs: [MGLAttributedExpressionKey : NSExpression] = [:])
    View Source on GitHub

MGLAttributionInfo


          @interface MGLAttributionInfo : NSObject

Information about an attribution statement, usually a copyright or trademark statement, associated with a map content source.

  • -initWithTitle:URL:

    Returns an initialized attribution info object with the given title and URL.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTitle:(nonnull NSAttributedString *)title
                                            URL:(nullable NSURL *)URL;

    Swift

    init(title: NSAttributedString, url URL: URL?)

    Parameters

    title

    The attribution statement’s title.
    URL

    A URL to more information about the entity named in the attribution.

    Return Value

    An initialized attribution info object.

    View Source on GitHub

  • title

    The attribution statement’s attributed title text.

    Declaration

    Objective-C

    @property (nonatomic) NSAttributedString *_Nonnull title;

    Swift

    var title: NSAttributedString { get set }
    View Source on GitHub

  • URL

    The URL to more information about the entity named in the attribution.

    If this property is set, the attribution statement should be displayed as a hyperlink or action button. Otherwise, if it is nil, the attribution statement should be displayed as plain text.

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSURL *URL;

    Swift

    var url: URL? { get set }
    View Source on GitHub

  • feedbackLink

    A Boolean value indicating whether the attribution statement is a shortcut to a feedback tool.

    If this property is set, the statement should be treated as a way for the user to provide feedback rather than an attribution statement.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
                    getter=isFeedbackLink) BOOL feedbackLink;

    Swift

    var isFeedbackLink: Bool { get set }
    View Source on GitHub

  • -titleWithStyle:

    Returns a copy of the current title formatted accordingly to style.

    Example: If the style property is set to MGLAttributionInfoStyleShort and the title property is set to OpenStreetMap, then this method returns OSM.

    Declaration

    Objective-C

    - (nonnull NSAttributedString *)titleWithStyle:(MGLAttributionInfoStyle)style;

    Swift

    func title(with style: MGLAttributionInfoStyle) -> NSAttributedString

    Parameters

    style

    The attribution info style.

    Return Value

    The NSAttributedString styled title.

    View Source on GitHub

MGLDefaultStyle


          @interface MGLDefaultStyle : NSObject

The MGLDefaultStyle defines the predefined vendor style

  • url

    The style URL

    Declaration

    Objective-C

    @property (nonatomic, retain) NSURL *_Nonnull url;

    Swift

    var url: URL { get set }
    View Source on GitHub

  • name

    The style name

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull name;

    Swift

    var name: String { get set }
    View Source on GitHub

  • version

    The style version

    Declaration

    Objective-C

    @property (nonatomic) int version;

    Swift

    var version: Int32 { get set }
    View Source on GitHub

MGLLoggingConfiguration


          @interface MGLLoggingConfiguration : NSObject

The MGLLoggingConfiguration object provides a global way to set this SDK logging levels and logging handler.

  • handler

    The handler this SDK uses to log messages.

    If this property is set to nil or if no custom handler is provided this property is set to the default handler.

    The default handler uses os_log and NSLog for iOS 10+ and iOS < 10 respectively.

    Declaration

    Objective-C

    @property (nonatomic, copy, null_resettable) MGLLoggingBlockHandler handler;

    Swift

    var handler: MGLLoggingBlockHandler! { get set }
    View Source on GitHub

  • loggingLevel

    The logging level.

    The default value is MGLLoggingLevelNone.

    Setting this property includes logging levels less than or equal to the setted value.

    Declaration

    Objective-C

    @property (nonatomic) MGLLoggingLevel loggingLevel;

    Swift

    var loggingLevel: MGLLoggingLevel { get set }
    View Source on GitHub

  • sharedConfiguration

    Returns the shared logging object.

    Declaration

    Objective-C

    @property (class, nonatomic, readonly) MGLLoggingConfiguration *_Nonnull sharedConfiguration;

    Swift

    class var shared: MGLLoggingConfiguration { get }
    View Source on GitHub

MGLMapProjection


          @interface MGLMapProjection : NSObject

The aim of this class is to provide the functionality of changing the camera state and converting between map view screen coordinates and geographical coordinates without changing the actual map view camera state.

  • -initWithMapView:

    Initializes and returns the new projection object with the current camera state from the provided map view.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMapView:(nonnull MGLMapView *)mapView;

    Swift

    init(mapView: MGLMapView)

    Parameters

    mapView

    The map view the camera state to use for the initialization.

    Return Value

    An initialized map projection.

    View Source on GitHub

  • camera

    A camera representing the current projection state

    Declaration

    Objective-C

    @property (copy, readonly) MGLMapCamera *_Nonnull camera;

    Swift

    @NSCopying var camera: MGLMapCamera { get }
    View Source on GitHub

  • -setCamera:withEdgeInsets:

    Change the projection state with camera and padding values.

    Note

    MGLMapView instance frame must not be changed since this projection is initialized, otherwise the calculation may be wrong.

    Declaration

    Objective-C

    - (void)setCamera:(MGLMapCamera *_Nonnull)camera
              withEdgeInsets:(UIEdgeInsets)insets;

    Swift

    func setCamera(_ camera: MGLMapCamera, with insets: UIEdgeInsets)

    Parameters

    camera

    The new camera to be used in the projection calculation.
    insets

    The insets applied on top of the camera be used in the projection calculation.
    View Source on GitHub

  • -setVisibleCoordinateBounds:edgePadding:

    Change the projection state to make the provided bounds visible with the specified inset.

    Note

    MGLMapView instance frame must not be changed since this projection is initialized, otherwise the calculation may be wrong.

    Declaration

    Objective-C

    - (void)setVisibleCoordinateBounds:(MGLCoordinateBounds)bounds
                                 edgePadding:(UIEdgeInsets)insets;

    Swift

    func setVisibleCoordinateBounds(_ bounds: MGLCoordinateBounds, edgePadding insets: UIEdgeInsets)

    Parameters

    bounds

    The bounds that the viewport should fit.
    insets

    The insets applied on top of the viewport to be used in the projection calculation.
    View Source on GitHub

  • -convertPoint:

    Converts a point in the coordinate system of the map view the projection was initialized with to the geographical coordinate.

    Declaration

    Objective-C

    - (CLLocationCoordinate2D)convertPoint:(CGPoint)point;

    Swift

    func convert(_ point: CGPoint) -> CLLocationCoordinate2D

    Parameters

    point

    The point to convert.

    Return Value

    The geographic coordinate at the given point.

    View Source on GitHub

  • -convertCoordinate:

    Converts a geographic coordinate to a point in the map view’s the projection was initialized with coordinate system.

    Declaration

    Objective-C

    - (CGPoint)convertCoordinate:(CLLocationCoordinate2D)coordinate;

    Swift

    func convert(_ coordinate: CLLocationCoordinate2D) -> CGPoint

    Parameters

    coordinate

    The geographic coordinate to convert.

    Return Value

    The point corresponding to the given geographic coordinate.

    View Source on GitHub

  • metersPerPoint

    The distance in meters spanned by a single point for the current camera.

    Declaration

    Objective-C

    @property (readonly) CLLocationDistance metersPerPoint;

    Swift

    var metersPerPoint: CLLocationDistance { get }
    View Source on GitHub

MGLMapSnapshotOverlay


          @interface MGLMapSnapshotOverlay : NSObject

An overlay that is placed within a MGLMapSnapshot. To access this object, use -[MGLMapSnapshotter startWithOverlayHandler:completionHandler:].

  • context

    The current CGContext that snapshot is drawing within. You may use this context to perform additional custom drawing.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGContextRef _Nonnull context;

    Swift

    var context: CGContext { get }
    View Source on GitHub

  • -pointForCoordinate:

    Converts the specified map coordinate to a point in the coordinate space of the context.

    Declaration

    Objective-C

    - (CGPoint)pointForCoordinate:(CLLocationCoordinate2D)coordinate;

    Swift

    func point(for coordinate: CLLocationCoordinate2D) -> CGPoint
    View Source on GitHub

  • -coordinateForPoint:

    Converts the specified context point to a map coordinate.

    Declaration

    Objective-C

    - (CLLocationCoordinate2D)coordinateForPoint:(CGPoint)point;

    Swift

    func coordinate(for point: CGPoint) -> CLLocationCoordinate2D
    View Source on GitHub

MGLNetworkConfiguration


          @interface MGLNetworkConfiguration : NSObject

The MGLNetworkConfiguration object provides a global way to set a base NSURLSessionConfiguration, and other resources.

  • sharedManager

    Returns the shared instance of the MGLNetworkConfiguration class.

    Declaration

    Objective-C

    @property (class, nonatomic, readonly) MGLNetworkConfiguration *_Nonnull sharedManager;

    Swift

    class var sharedManager: MGLNetworkConfiguration { get }
    View Source on GitHub

  • sessionConfiguration

    The session configuration object that is used by the NSURLSession objects in this SDK.

    If this property is set to nil or if no session configuration is provided this property is set to the default session configuration.

    Assign this object before instantiating any MGLMapView object, or using MGLOfflineStorage

    Note

    NSURLSession objects store a copy of this configuration. Any further changes to mutable properties on this configuration object passed to a session’s initializer will not affect the behavior of that session.

    Note

    Background sessions are not currently supported.

    Declaration

    Objective-C

    @property (strong, null_resettable) NSURLSessionConfiguration *sessionConfiguration;

    Swift

    var sessionConfiguration: URLSessionConfiguration! { get set }
    View Source on GitHub

MGLTileServerOptions


          @interface MGLTileServerOptions : NSObject

The MGLTileServerOptions defines server properties such as URL etc…

  • baseURL

    API base URL.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull baseURL;

    Swift

    var baseURL: String { get set }
    View Source on GitHub

  • uriSchemeAlias

    Tile server URI alias.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull uriSchemeAlias;

    Swift

    var uriSchemeAlias: String { get set }
    View Source on GitHub

  • sourceTemplate

    URL template for sources.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull sourceTemplate;

    Swift

    var sourceTemplate: String { get set }
    View Source on GitHub

  • sourceDomainName

    source domain name.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull sourceDomainName;

    Swift

    var sourceDomainName: String { get set }
    View Source on GitHub

  • sourceVersionPrefix

    source version prefix

    Declaration

    Objective-C

    @property (nonatomic, retain, nullable) NSString *sourceVersionPrefix;

    Swift

    var sourceVersionPrefix: String? { get set }
    View Source on GitHub

  • styleTemplate

    URL template for style.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull styleTemplate;

    Swift

    var styleTemplate: String { get set }
    View Source on GitHub

  • styleDomainName

    style domain name.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull styleDomainName;

    Swift

    var styleDomainName: String { get set }
    View Source on GitHub

  • styleVersionPrefix

    style version prefix

    Declaration

    Objective-C

    @property (nonatomic, retain, nullable) NSString *styleVersionPrefix;

    Swift

    var styleVersionPrefix: String? { get set }
    View Source on GitHub

  • spritesTemplate

    URL template for sprites.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull spritesTemplate;

    Swift

    var spritesTemplate: String { get set }
    View Source on GitHub

  • spritesDomainName

    sprites domain name.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull spritesDomainName;

    Swift

    var spritesDomainName: String { get set }
    View Source on GitHub

  • spritesVersionPrefix

    version prefix

    Declaration

    Objective-C

    @property (nonatomic, retain, nullable) NSString *spritesVersionPrefix;

    Swift

    var spritesVersionPrefix: String? { get set }
    View Source on GitHub

  • glyphsTemplate

    URL template for glyphs.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull glyphsTemplate;

    Swift

    var glyphsTemplate: String { get set }
    View Source on GitHub

  • glyphsDomainName

    glyphs domain name.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull glyphsDomainName;

    Swift

    var glyphsDomainName: String { get set }
    View Source on GitHub

  • glyphsVersionPrefix

    Glyphs version prefix

    Declaration

    Objective-C

    @property (nonatomic, retain, nullable) NSString *glyphsVersionPrefix;

    Swift

    var glyphsVersionPrefix: String? { get set }
    View Source on GitHub

  • tileTemplate

    URL template for tiles.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull tileTemplate;

    Swift

    var tileTemplate: String { get set }
    View Source on GitHub

  • tileDomainName

    tile domain name.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull tileDomainName;

    Swift

    var tileDomainName: String { get set }
    View Source on GitHub

  • tileVersionPrefix

    tile version prefix

    Declaration

    Objective-C

    @property (nonatomic, retain, nullable) NSString *tileVersionPrefix;

    Swift

    var tileVersionPrefix: String? { get set }
    View Source on GitHub

  • apiKeyParameterName

    API key parameter name.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSString *_Nonnull apiKeyParameterName;

    Swift

    var apiKeyParameterName: String { get set }
    View Source on GitHub

  • defaultStyles

    Default styles.

    Declaration

    Objective-C

    @property (nonatomic, retain) NSArray<MGLDefaultStyle *> *_Nonnull defaultStyles;

    Swift

    var defaultStyles: [MGLDefaultStyle] { get set }
    View Source on GitHub

  • defaultStyle

    Default style

    Declaration

    Objective-C

    @property (nonatomic, retain) MGLDefaultStyle *_Nonnull defaultStyle;

    Swift

    var defaultStyle: MGLDefaultStyle { get set }
    View Source on GitHub

MGLUserLocationAnnotationViewStyle 


          @interface MGLUserLocationAnnotationViewStyle : NSObject

A class containing information about the default User Location annotation view style.

  • puckFillColor

    The fill color for the puck view.

    Declaration

    Objective-C

    @property (nonatomic) UIColor *_Nonnull puckFillColor;

    Swift

    var puckFillColor: UIColor { get set }
    View Source on GitHub

  • puckShadowColor

    The shadow color for the puck view.

    Declaration

    Objective-C

    @property (nonatomic) UIColor *_Nonnull puckShadowColor;

    Swift

    var puckShadowColor: UIColor { get set }
    View Source on GitHub

  • puckShadowOpacity

    The shadow opacity for the puck view. Set any value between 0.0 and 1.0. The default value of this property is equal to 0.25

    Declaration

    Objective-C

    @property (nonatomic) CGFloat puckShadowOpacity;

    Swift

    var puckShadowOpacity: CGFloat { get set }
    View Source on GitHub

  • puckArrowFillColor

    The fill color for the arrow puck.

    Declaration

    Objective-C

    @property (nonatomic) UIColor *_Nonnull puckArrowFillColor;

    Swift

    var puckArrowFillColor: UIColor { get set }
    View Source on GitHub

  • haloFillColor

    The fill color for the puck view.

    Declaration

    Objective-C

    @property (nonatomic) UIColor *_Nonnull haloFillColor;

    Swift

    var haloFillColor: UIColor { get set }
    View Source on GitHub

  • approximateHaloFillColor

    The halo fill color for the approximate view.

    Declaration

    Objective-C

    @property (nonatomic) API_AVAILABLE(ios(14)) UIColor *approximateHaloFillColor;

    Swift

    var approximateHaloFillColor: UIColor { get set }
    View Source on GitHub

  • approximateHaloBorderColor

    The halo border color for the approximate view.

    Declaration

    Objective-C

    @property (nonatomic) API_AVAILABLE(ios(14)) UIColor *approximateHaloBorderColor;

    Swift

    var approximateHaloBorderColor: UIColor { get set }
    View Source on GitHub

  • approximateHaloBorderWidth

    The halo border width for the approximate view. The default value of this property is equal to 2.0

    Declaration

    Objective-C

    @property (nonatomic) CGFloat approximateHaloBorderWidth;

    Swift

    var approximateHaloBorderWidth: CGFloat { get set }
    View Source on GitHub

  • approximateHaloOpacity

    The halo opacity for the approximate view. Set any value between 0.0 and 1.0 The default value of this property is equal to 0.15

    Declaration

    Objective-C

    @property (nonatomic) CGFloat approximateHaloOpacity;

    Swift

    var approximateHaloOpacity: CGFloat { get set }
    View Source on GitHub